<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::sprite_palettes namespace | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>sprite_palettes <span class="m-thin">namespace</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__sprite__palettes_8h.html">&lt;bn_sprite_palettes.h&gt;</a></div>
        </h1>
        <p>Sprite color palettes related functions.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#func-members">Functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
        <section id="func-members">
          <h2><a href="#func-members">Functions</a></h2>
          <dl class="m-doc">
            <dt id="a7883186ea543257da0fa8c445f59722c">
              <span class="m-doc-wrap-bumper">auto <a href="#a7883186ea543257da0fa8c445f59722c" class="m-doc-self">used_colors_count</a>(</span><span class="m-doc-wrap">) -&gt; int</span>
            </dt>
            <dd>Returns the number of used sprite colors.</dd>
            <dt id="a98aac1fc59704dec5939ed8353de4781">
              <span class="m-doc-wrap-bumper">auto <a href="#a98aac1fc59704dec5939ed8353de4781" class="m-doc-self">available_colors_count</a>(</span><span class="m-doc-wrap">) -&gt; int</span>
            </dt>
            <dd>Returns the number of available sprite colors.</dd>
            <dt id="a5654ce9c38c5e76d5af395eb1f66bda6">
              <span class="m-doc-wrap-bumper">auto <a href="#a5654ce9c38c5e76d5af395eb1f66bda6" class="m-doc-self">brightness</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the brightness of all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a3ae0a6f00d574ee4fc717f105980bc5e" class="m-doc">set_brightness</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> brightness)</span>
            </dt>
            <dd>Sets the brightness of all sprite color palettes.</dd>
            <dt id="ab819718be5e595f92b4cfc95a31c8dba">
              <span class="m-doc-wrap-bumper">auto <a href="#ab819718be5e595f92b4cfc95a31c8dba" class="m-doc-self">contrast</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the contrast of all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a26e5c530927fcea577eeae3b298fc945" class="m-doc">set_contrast</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> contrast)</span>
            </dt>
            <dd>Sets the contrast of all sprite color palettes.</dd>
            <dt id="a340ba93c62dc72b55ff2eae9da555316">
              <span class="m-doc-wrap-bumper">auto <a href="#a340ba93c62dc72b55ff2eae9da555316" class="m-doc-self">intensity</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the intensity of all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ac2a3c398a894d8de79e58dd3675e0b1a" class="m-doc">set_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span>
            </dt>
            <dd>Sets the intensity of all sprite color palettes.</dd>
            <dt id="ab4917dd3a877a28c048d66b715c8a1d0">
              <span class="m-doc-wrap-bumper">auto <a href="#ab4917dd3a877a28c048d66b715c8a1d0" class="m-doc-self">inverted</a>(</span><span class="m-doc-wrap">) -&gt; bool</span>
            </dt>
            <dd>Indicates if the colors of all sprite color palettes are inverted or not.</dd>
            <dt id="ade93d86fa304279e2f36995a8b2be365">
              <span class="m-doc-wrap-bumper">void <a href="#ade93d86fa304279e2f36995a8b2be365" class="m-doc-self">set_inverted</a>(</span><span class="m-doc-wrap">bool inverted)</span>
            </dt>
            <dd>Sets if the colors of all sprite color palettes must be inverted or not.</dd>
            <dt id="a55d1da424bd3a2c116303acaf3e2adde">
              <span class="m-doc-wrap-bumper">auto <a href="#a55d1da424bd3a2c116303acaf3e2adde" class="m-doc-self">grayscale_intensity</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the intensity of the grayscale effect applied to all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ad793f7d303292c99e754d2c9715b7fe9" class="m-doc">set_grayscale_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span>
            </dt>
            <dd>Sets the intensity of the grayscale effect applied to all sprite color palettes.</dd>
            <dt id="a0d2531484dd53c5c0c2c8c7473552849">
              <span class="m-doc-wrap-bumper">auto <a href="#a0d2531484dd53c5c0c2c8c7473552849" class="m-doc-self">hue_shift_intensity</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the intensity of the hue shift effect applied to all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#af5d0db3fd3640d6789bfda70805a6b9a" class="m-doc">set_hue_shift_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span>
            </dt>
            <dd>Sets the intensity of the hue shift effect applied to all sprite color palettes.</dd>
            <dt id="a8afcadcff20a2c6cee41a43024c4e924">
              <span class="m-doc-wrap-bumper">auto <a href="#a8afcadcff20a2c6cee41a43024c4e924" class="m-doc-self">fade_color</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1color.html" class="m-doc">color</a></span>
            </dt>
            <dd>Returns the color of the fade effect applied to all sprite color palettes.</dd>
            <dt id="a01107b5dee5a7c4c3b192471301c1770">
              <span class="m-doc-wrap-bumper">auto <a href="#a01107b5dee5a7c4c3b192471301c1770" class="m-doc-self">fade_intensity</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the intensity of the fade effect applied to all sprite color palettes.</dd>
            <dt id="a927f4b57c17f8ba7b5b04a0dcebafe03">
              <span class="m-doc-wrap-bumper">void <a href="#a927f4b57c17f8ba7b5b04a0dcebafe03" class="m-doc-self">set_fade_color</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1color.html" class="m-doc">color</a> color)</span>
            </dt>
            <dd>Sets the color of the fade effect applied to all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a8ab6225587a3de02041b9c5c095cc0aa" class="m-doc">set_fade_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span>
            </dt>
            <dd>Sets the intensity of the fade effect applied to all sprite color palettes.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a796119b468a0e4a80ac9eae04caebbc7" class="m-doc">set_fade</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1color.html" class="m-doc">color</a> color,
              <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span>
            </dt>
            <dd>Sets the color and the intensity of the fade effect applied to all sprite color palettes.</dd>
            <dt id="a7572f94dfc4c932b39faac1e02c3961a">
              <span class="m-doc-wrap-bumper">auto <a href="#a7572f94dfc4c932b39faac1e02c3961a" class="m-doc-self">custom_effect</a>(</span><span class="m-doc-wrap">) -&gt; <a href="namespacebn.html#ab241f34495f92d9bf08c68c2d671dea3" class="m-doc">palette_<wbr />effect_<wbr />type</a></span>
            </dt>
            <dd>Returns the custom effect applied to all sprite color palettes.</dd>
            <dt id="afe51a2df4369624b94b68e4a1b444d86">
              <span class="m-doc-wrap-bumper">void <a href="#afe51a2df4369624b94b68e4a1b444d86" class="m-doc-self">set_custom_effect</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#ab241f34495f92d9bf08c68c2d671dea3" class="m-doc">palette_<wbr />effect_<wbr />type</a> effect)</span>
            </dt>
            <dd>Sets the custom effect applied to all sprite color palettes.</dd>
            <dt id="a051410b971b7fed545b9cf187e187032">
              <span class="m-doc-wrap-bumper">void <a href="#a051410b971b7fed545b9cf187e187032" class="m-doc-self">reload_custom_effect</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Reapplies the custom effect to all sprite color palettes.</dd>
            <dt id="a029d633f1be5d839af468a9c8e02b986">
              <span class="m-doc-wrap-bumper">void <a href="#a029d633f1be5d839af468a9c8e02b986" class="m-doc-self">log_status</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Logs the current status of the sprite color palettes manager.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="a3ae0a6f00d574ee4fc717f105980bc5e"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3ae0a6f00d574ee4fc717f105980bc5e" class="m-doc-self">set_brightness</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> brightness)</span></span>
            </h3>
            <p>Sets the brightness of all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">brightness</td>
                  <td>New brightness in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a26e5c530927fcea577eeae3b298fc945"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a26e5c530927fcea577eeae3b298fc945" class="m-doc-self">set_contrast</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> contrast)</span></span>
            </h3>
            <p>Sets the contrast of all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">contrast</td>
                  <td>New contrast in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="ac2a3c398a894d8de79e58dd3675e0b1a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ac2a3c398a894d8de79e58dd3675e0b1a" class="m-doc-self">set_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span></span>
            </h3>
            <p>Sets the intensity of all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">intensity</td>
                  <td>New intensity in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="ad793f7d303292c99e754d2c9715b7fe9"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad793f7d303292c99e754d2c9715b7fe9" class="m-doc-self">set_grayscale_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span></span>
            </h3>
            <p>Sets the intensity of the grayscale effect applied to all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">intensity</td>
                  <td>New intensity in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="af5d0db3fd3640d6789bfda70805a6b9a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af5d0db3fd3640d6789bfda70805a6b9a" class="m-doc-self">set_hue_shift_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span></span>
            </h3>
            <p>Sets the intensity of the hue shift effect applied to all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">intensity</td>
                  <td>New intensity in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a8ab6225587a3de02041b9c5c095cc0aa"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8ab6225587a3de02041b9c5c095cc0aa" class="m-doc-self">set_fade_intensity</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span></span>
            </h3>
            <p>Sets the intensity of the fade effect applied to all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">intensity</td>
                  <td>New intensity in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a796119b468a0e4a80ac9eae04caebbc7"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />sprite_palettes::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a796119b468a0e4a80ac9eae04caebbc7" class="m-doc-self">set_fade</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1color.html" class="m-doc">color</a> color,
              <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> intensity)</span></span>
            </h3>
            <p>Sets the color and the intensity of the fade effect applied to all sprite color palettes.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">color</td>
                  <td>New color.</td>
                </tr>
                <tr>
                  <td>intensity</td>
                  <td>New intensity in the range [0..1].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
